Skip to main content
Feedback

Creating a document cache

When you create a Document Cache component, you must select a profile type and add indexes and keys for organizing the data in the cached documents.

  1. On the Build page, do one of the following:

    • Click Create New and select Document Cache from the list.

    • In the Component Explorer, click the three vertical dots next to the desired folder, select New Component, and select Document Cache.

  2. In the Profile Type list, do one of the following:

    • To cache documents based on a profile, select a profile type: XML, EDI, Database (Legacy), Flat File, or JSON.

    • To cache document that are not based on a profile, select a profile type of Any.

  3. Optional: If you selected a specific profile type, choose or create a profile of the appropriate type.

  4. Optional: If you do not require a one-to-one relationship between index keys and documents, you can clear the Enforce one index entry per document option.

    If you clear this option, you cannot perform the following actions when you use the Document Cache component in a process:

    • Retrieve all documents from the document cache.

    • Remove specific documents from the document cache by index name.

  5. Click Add Index.

  6. Type an index name and click OK.

    If you do not type an index name, it appears as “Unnamed”.

    If you selected a specific profile type, you can add profile element keys or document property keys.

  7. To add a profile element key:

    1. Click Add Profile Element Key.

    2. Type a name for the key.

      If you do not type a key name, this field populates when you select an element.

    3. Browse the key's element and click OK.

    4. Click Save.

  8. To add a document property key:

    1. Click Add Document Property Key.

    2. Type a name for the key.

      If you do not type a key name, this field populates when you select an element.

    3. Click the Browse icon.

      The Choose Property dialog opens.

    4. Select Document Property, and then click OK.

    5. Select the source type for which you are defining document properties. Based on your selection, you then select a specific connector and/or properties.

    6. Click Save.

  9. To add a dynamic document property key:

    1. Click Add Document Property Key.

    2. Type a name for the key.

      If you do not type a key name, this field populates when you select an element.

    3. Click the Browse icon.

      The Choose Property dialog opens.

    4. Select Dynamic Document Property, enter the property name, enter the default value, and then click OK.

    5. Click Save.

  10. To add a MIME property key:

    1. Click Add Document Property Key.

    2. Type a name for the key.

      If you do not type a key name, this field populates when you select an element.

    3. Click the Browse icon.

      The Choose Property dialog opens.

    4. Select MIME Property, select the property name, and then click OK. Enter a custom property value when you select a custom property name.

    5. Click Save.

  11. Optional: To add more keys to the index, repeat steps 7, 8, 9, and 10.

  12. To add more indexes and keys, repeat steps 6–10.

  13. Click Save or Save and Close.